Extrato Periódico
Delfinance gera relatórios automaticamente todos os dias para fácil acesso. No final de cada mês, um arquivo consolidado é criado, contendo todos os dados do período mensal.
Listar relatórios disponíveis
Para recuperar a lista de relatórios disponíveis, faça uma solicitação GET para o seguinte ponto de extremidade:
- URL
- cURL
GET https://apisandbox.delbank.com.br/baas/api/v1/customer-reports
curl -X GET "https://apisandbox.delbank.com.br/baas/api/v1/customer-reports" \
-H "x-delbank-api-key: {apiKey}"
Resposta:
[
{
"id": 1058,
"description": "Extrato com 35837 transações",
"progress": 100,
"period": {
"startDate": "2025-03-14T03:00:00Z",
"endDate": "2025-03-15T03:00:00Z"
},
"status": {
"name": "FINISHED",
"description": "Concluído"
},
"reportType": {
"name": "BANKSTATEMENT",
"description": "Extrato bancário"
}
}
]
Um relatório com status: FINISHED
está pronto para download.
Obter detalhes do relatório
Depois de obter o ID do relatório, faça uma solicitação GET para verificar seus detalhes e ver se um arquivo está disponível.
- URL
- cURL
GET https://apisandbox.delbank.com.br/baas/api/v1/customer-reports/:id
curl -X GET "https://apisandbox.delbank.com.br/baas/api/v1/customer-reports/1058" \
-H "x-delbank-api-key: {apiKey}"
Resposta:
{
"id": 1058,
"description": "Extrato com 35837 transações",
"progress": 100,
"period": {
"startDate": "2025-03-14T03:00:00Z",
"endDate": "2025-03-15T03:00:00Z"
},
"status": {
"name": "FINISHED",
"description": "Concluído"
},
"reportType": {
"name": "BANKSTATEMENT",
"description": "Extrato bancário"
},
"files": [
{
"name": "14032025-00h00m00s_14032025-23h59m59s_00001",
"link": "https://bucket.s3.amazonaws.com/Reports/032025-23h59m59s_00001.csv?...",
"size": 7472779
}
]
}
⚠️ Se a matriz files
estiver vazia, o relatório ainda está sendo processado ou não tem arquivos disponíveis.
Baixando o Relatório
Para baixar, use a URL files.link
da resposta. Este link fornece acesso direto ao relatório armazenado no S3.
🔹 Observações importantes:
- O link expira após um certo período.
- Use-o imediatamente para evitar problemas de acesso.
Exemplo - Terminal Linux/MacOS:
wget "https://bucket.s3.amazonaws.com/Reports/032025-23h59m59s_00001.csv?..."
Ou simplesmente copie e cole o link no seu navegador.
Formato de fluxo
Neste método, você solicita o arquivo diretamente, sem precisar recuperar o ID do relatório manualmente.
Endpoint:
GET https://apisandbox.delbank.com.br/baas/api/v1/customer-reports/bankstatement/{pattern}/stream
(padrão) Formatos de parâmetros:
- aaaaMMdd → Exemplo:
20250310
(10 de março de 2025) - aaaaMM → Exemplo:
202503
(março de 2025)
Se um relatório estiver disponível para o período especificado, o servidor transmitirá o arquivo diretamente, assim como acessar o link S3.